home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / sstein.z / sstein
Encoding:
Text File  |  2002-10-03  |  5.7 KB  |  199 lines
  1.  
  2.  
  3.  
  4. SSSSSSSSTTTTEEEEIIIINNNN((((3333SSSS))))                                                          SSSSSSSSTTTTEEEEIIIINNNN((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      SSTEIN - compute the eigenvectors of a real symmetric tridiagonal matrix
  10.      T corresponding to specified eigenvalues, using inverse iteration
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE SSTEIN( N, D, E, M, W, IBLOCK, ISPLIT, Z, LDZ, WORK, IWORK,
  14.                         IFAIL, INFO )
  15.  
  16.          INTEGER        INFO, LDZ, M, N
  17.  
  18.          INTEGER        IBLOCK( * ), IFAIL( * ), ISPLIT( * ), IWORK( * )
  19.  
  20.          REAL           D( * ), E( * ), W( * ), WORK( * ), Z( LDZ, * )
  21.  
  22. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  23.      These routines are part of the SCSL Scientific Library and can be loaded
  24.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  25.      directs the linker to use the multi-processor version of the library.
  26.  
  27.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  28.      4 bytes (32 bits). Another version of SCSL is available in which integers
  29.      are 8 bytes (64 bits).  This version allows the user access to larger
  30.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  31.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  32.      only one of the two versions; 4-byte integer and 8-byte integer library
  33.      calls cannot be mixed.
  34.  
  35. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  36.      SSTEIN computes the eigenvectors of a real symmetric tridiagonal matrix T
  37.      corresponding to specified eigenvalues, using inverse iteration. The
  38.      maximum number of iterations allowed for each eigenvector is specified by
  39.      an internal parameter MAXITS (currently set to 5).
  40.  
  41.  
  42. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  43.      N       (input) INTEGER
  44.              The order of the matrix.  N >= 0.
  45.  
  46.      D       (input) REAL array, dimension (N)
  47.              The n diagonal elements of the tridiagonal matrix T.
  48.  
  49.      E       (input) REAL array, dimension (N)
  50.              The (n-1) subdiagonal elements of the tridiagonal matrix T, in
  51.              elements 1 to N-1.  E(N) need not be set.
  52.  
  53.      M       (input) INTEGER
  54.              The number of eigenvectors to be found.  0 <= M <= N.
  55.  
  56.      W       (input) REAL array, dimension (N)
  57.              The first M elements of W contain the eigenvalues for which
  58.              eigenvectors are to be computed.  The eigenvalues should be
  59.              grouped by split-off block and ordered from smallest to largest
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSSSSSTTTTEEEEIIIINNNN((((3333SSSS))))                                                          SSSSSSSSTTTTEEEEIIIINNNN((((3333SSSS))))
  71.  
  72.  
  73.  
  74.              within the block.  ( The output array W from SSTEBZ with ORDER =
  75.              'B' is expected here. )
  76.  
  77.      IBLOCK  (input) INTEGER array, dimension (N)
  78.              The submatrix indices associated with the corresponding
  79.              eigenvalues in W; IBLOCK(i)=1 if eigenvalue W(i) belongs to the
  80.              first submatrix from the top, =2 if W(i) belongs to the second
  81.              submatrix, etc.  ( The output array IBLOCK from SSTEBZ is
  82.              expected here. )
  83.  
  84.      ISPLIT  (input) INTEGER array, dimension (N)
  85.              The splitting points, at which T breaks up into submatrices.  The
  86.              first submatrix consists of rows/columns 1 to ISPLIT( 1 ), the
  87.              second of rows/columns ISPLIT( 1 )+1 through ISPLIT( 2 ), etc.  (
  88.              The output array ISPLIT from SSTEBZ is expected here. )
  89.  
  90.      Z       (output) REAL array, dimension (LDZ, M)
  91.              The computed eigenvectors.  The eigenvector associated with the
  92.              eigenvalue W(i) is stored in the i-th column of Z.  Any vector
  93.              which fails to converge is set to its current iterate after
  94.              MAXITS iterations.
  95.  
  96.      LDZ     (input) INTEGER
  97.              The leading dimension of the array Z.  LDZ >= max(1,N).
  98.  
  99.      WORK    (workspace) REAL array, dimension (5*N)
  100.  
  101.      IWORK   (workspace) INTEGER array, dimension (N)
  102.  
  103.      IFAIL   (output) INTEGER array, dimension (M)
  104.              On normal exit, all elements of IFAIL are zero.  If one or more
  105.              eigenvectors fail to converge after MAXITS iterations, then their
  106.              indices are stored in array IFAIL.
  107.  
  108.      INFO    (output) INTEGER
  109.              = 0: successful exit.
  110.              < 0: if INFO = -i, the i-th argument had an illegal value
  111.              > 0: if INFO = i, then i eigenvectors failed to converge in
  112.              MAXITS iterations.  Their indices are stored in array IFAIL.
  113.  
  114. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRRSSSS
  115.      MAXITS  INTEGER, default = 5
  116.              The maximum number of iterations performed.
  117.  
  118.      EXTRA   INTEGER, default = 2
  119.              The number of iterations performed after norm growth criterion is
  120.              satisfied, should be at least 1.
  121.  
  122. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  123.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. SSSSSSSSTTTTEEEEIIIINNNN((((3333SSSS))))                                                          SSSSSSSSTTTTEEEEIIIINNNN((((3333SSSS))))
  137.  
  138.  
  139.  
  140.      This man page is available only online.
  141.  
  142.  
  143.  
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.